home *** CD-ROM | disk | FTP | other *** search
/ Night Owl - The Best of BBS / Night Owl The Best of BBS (NOP-BBS) (Night Owl Publisher) (1994).iso / 022a / jm940310.lha / jamscan.doc < prev    next >
Text File  |  1994-02-19  |  7KB  |  202 lines
  1.  
  2.  
  3.                          -==* JamScan 0.55 *==-
  4.                            By James McOrmond
  5.  
  6.                           Octobert 4th, 1993
  7.  
  8.  
  9.  
  10.  
  11.  
  12. What is JamScan?
  13.  
  14. JamScan is a complete replacement for JBundle, an Arexx script I wrote
  15. last year, to bundle up uncompressed packets of mail, and to add them
  16. to Xferq.library to be sent out during a session.
  17.  
  18. JamScan does more than JBundle ever did, and it also does it much faster!
  19.  
  20. (JamScan is also pure for those of you that want things as fast as
  21. possible and like to make things resident)
  22.  
  23. The reason I wrote JamScan at this time, is that with the release of
  24. JamMail, I figured people would want a relatively fast and easy to use
  25. program that will fix up the files in their outbound directory.
  26.  
  27.  
  28. How does it work?
  29.  
  30. When you run JamScan, it will check for an Env: variable named "JAMSCAN"
  31. and if it exists, it will use the contents as the filename for the config
  32. file.  If no ENV: variable exists, the default is Mail:JamScan.cfg.
  33.  
  34. After reading the config file, it will scan your packets directory for
  35. files that fit any of your route patterns.  If the filename fits the
  36. pattern "#?.?ut", it will compress the packet into a bundle that already
  37. exists for that system, or it will create a new bundle.
  38.  
  39. If it finds a bundle in the outbound directory, it will make sure that
  40. the file is being sent to that system (if your tosser already does the
  41. archiving, this is what you'll likely be using).  This method is not as
  42. safe as the first option, but it is required until more tossers are
  43. Xferq.Library aware.
  44.  
  45. The priority that these files are sent with is configured one of two ways.
  46. If you specify "Hold", "Crash", or "Direct", the file will have the the
  47. priority that the specific type has (Defaults are: -50 for hold, +30 for
  48. direct and +50 for crash).  If this is a bundle that JamScan is just
  49. trying to add to Xferq a setting of "Norm" will result in a priority of
  50. 0.  If this is a Bundle that JamScan has just added a packet to, it will
  51. check the 3rd last character in the origional filename and set the
  52. priority appropriate to that character.  (C=Crash, D=Direct, H=Hold).
  53.  
  54.  
  55.  
  56. How Do I install JamScan?
  57.  
  58. JamScan is very easy to install.  There are really only two relevent
  59. files.  The JamScan binary itself should be put somewhere in your search
  60. path.  If you have a directory where Networking software goes, this is
  61. likely a good place.  The other file is your config file.  I myself have
  62. the config file in my Mail: directory, but you can locate it wherever you
  63. wish.  If your config file is not Mail:JamScan.cfg, you need to specify
  64. the full path name to get to your config file in the JamScan Environment
  65. variable.
  66.  
  67.  
  68.  
  69. Configuring JamScan:
  70.  
  71. There are 8 different commands that JamScan understands in its config
  72. file.  They are as follows:
  73.  
  74. HOST    - Your Host address
  75. HOLD    - The default Priority for "Hold" mail
  76. DIRECT  - The default Priority for "Direct" mail
  77. CRASH   - The default priority for "Crash" mail
  78. BUNDLES - The Directory Bundles will be placed
  79. PACKETS - The directory Packets will be searched for
  80. PKTS    - The directory temporary compression directories will be made
  81. ROUTE   - The actual Routing command.
  82.  
  83.  
  84. The "Packets" and the "Pkts" directories must be on the same device.  I
  85. have placed the Pkts directory as a Sub-directory in the Packets
  86. directory, you may wish to do the same.
  87.  
  88. The only keyword that is absolutely required is at least one ROUTE
  89. keyword.  Without any ROUTE lines, JamScan won't do anything.
  90.  
  91.  
  92.  
  93. How do I setup a Route line?
  94.  
  95. A route line can have 4 arguments on the line.  The first two are
  96. mandatory, but the last two are not.
  97.  
  98. The first argument is the filename pattern.  This is the filename as it
  99. appears in your PACKETS directory.  Each name in this field should end
  100. with a #? unless you are wanting to specify the whole filename.  This
  101. field uses full AmigaDos2.0 pattern matching.  This can get really
  102. powerful and complicated, so you may want to read your AmigaDos manual
  103. for some hints on using strange patterns.
  104.  
  105. The Second Argument, is the Xferq.Library compatible address that the
  106. file will be sent to.  This can be anything from a single number, which
  107. it will assume is another node in your Net (by using the defaults in
  108. your "HOST" keyword, and the Host address you have setup with Xferq
  109. itself), to a full 5d FTN address.
  110.  
  111. You can also put a Non-Fidonet address type in this field, and it will
  112. work fine.
  113.  
  114. The last two fields are the Archiver type and the priority.  The defaults
  115. are the "Lha" archiver, and a "Norm" priority setting.  Either or both
  116. of these two settings can be left out, and they can be in either order.
  117.  
  118. The outbound compressors supported are "Lha", "Lzh", "Arc", "Zoo", and
  119. "Zip".  A setting of "Non" is also partially supported, but not fully
  120. working (as it isn't something people use often so wasn't a high priority).
  121.  
  122. Also, if one of these two fields is found to be a number (non-0 value)
  123. then this number will be used directly as the priority that the files
  124. will be sent with.
  125.  
  126.  
  127. Example Config File:
  128.  
  129. ; Your Host Address (2d is required, any extra is allowed)
  130. HOST 1:163/139
  131.  
  132. ; Settings for the default priorities
  133. HOLD -50
  134. DIRECT 30
  135. CRASH 50
  136.  
  137. ; Directory where outbound bundles will be put.
  138. BUNDLES outbound:
  139.  
  140. ; Directory to search for outbound files
  141. PACKETS outbound:
  142.  
  143. ; Directory root used to create temporary compression directories
  144. PKTS outbound:packets/
  145.  
  146. route 18.110.#?        ZyXELNET#18:110/0.0   lzh norm
  147. route 1.167.#?         ZyXELNET#18:110/0.0   lzh norm
  148.  
  149. route 18.163.?11.#?    FidoNet#18:163/311.0  lzh crash
  150. route 1.163.311.#?     FidoNet#18:163/311.0  lzh crash
  151.  
  152. route 16.#?.#?         ZyXELNET#16:16/0.0    lzh norm
  153. route 2.#?             ZyXELNET#16:16/0.0    lzh norm
  154.  
  155. route 18.21.#?         FidoNet#18:21/0.0     lzh norm
  156. route 1.2402.#?        FidoNet#18:21/0.0     lzh norm
  157.  
  158. route 18.700.#?        ZyXELNET#18:700/3.0   lzh norm
  159. route 1.105.#?         ZyXELNET#18:700/3.0   lzh norm
  160. route 1.102.#?         ZyXELNET#18:700/3.0   lzh norm
  161. route 1.106.#?         ZyXELNET#18:700/3.0   lzh norm
  162. route 1.3639.#?        ZyXELNET#18:700/3.0   lzh norm
  163.  
  164. route 18.24.#?         FidoNet#18:24/0.0     lzh norm
  165. route 1.121.#?         FidoNet#18:24/0.0     lzh norm
  166.  
  167. route 18.26.#?         FidoNet#18:26/0.0     lzh norm
  168. route 1.260.#?         FidoNet#18:26/0.0     lzh norm
  169.  
  170. route 18.105.100.#?    ZyXELNET#18:105/100.0 lzh norm
  171. route 1.250.#?         FidoNet#1:163/99.0    lzh crash
  172.  
  173. route 1.163.1?9.38.#?  FidoNet#1:163/109.38  lzh crash
  174.  
  175. route 1.163.109.#?     FidoNet#1:163/109.0   lzh crash
  176.  
  177. route 1.163.13(3|4).#? FidoNet#1:163/134.0   lzh crash
  178.  
  179. route 1.163.99.#?      FidoNet#1:163/99.0    lzh crash
  180. route 1.163.547.#?     FidoNet#1:163/547.0   lzh crash
  181.  
  182. route 1.163.452.#?     Fidonet#1:163/452.0   lzh crash
  183.  
  184. route 1.163.139.8.#?   FidoNet#1:163/139.8   lzh hold
  185.  
  186.  
  187. History:
  188.  
  189. 0.54 - initial release, October 4
  190.  
  191. 0.55 - minor tweeks, October 16
  192.  
  193. 0.56 - Adding support for converting .FLO files. (not finished)
  194.  
  195. February 94
  196. 0.57 - Raised number of route lines to 200 (the limit of 50 had been hit)
  197.        Changed to SAS 6.3 from Lattice 5.10b
  198.  
  199. 0.58 - Adding pattern matching ability to destination address field
  200.        "*" is the pattern.
  201.  
  202.